// Copyright (C) 2010  Joan Puigcerver Perez, <joapuipe@gmail.com>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//

#ifndef __NODE_HPP__
#define __NODE_HPP__

#include <list>

#include <BasicTypes.hpp>

class Link;

/**
 * \class Node
 *
 * Class used to represent a generic node in the persons & movies granph.
 * This is the base class for Person and Movie classes, used as nodes
 * in the bipartite graph.
 * \see Movie
 * \see Person
 *
 */
class Node {
protected:
  /** This stores the Node identifier as a 32-bit unsigned integer. */
  const uint32_t _id;
  /** List of links to adjacent nodes. */
  std::list<const Link *> links;
public:
  /**
   * Constructor. It only sets the Node identifier.
   * @param id Node identifier.
   */
  Node(const uint32_t id);

  /**
   * This function adds a link to the connected links list.
   * @param link New link.
   */
  void add_link(const Link * link);

  /**
   * This returns the Node identifier.
   */
  uint32_t id(void) const;

  /**
   * Returns the const_iterator to the first item in links list.
   * Used to iterate through the node's links.
   */
  std::list<const Link *>::const_iterator begin() const;

  /**
   * Returns the const_iterator to the end of the links list.
   * Used to iterate through the node's links.
   */
  std::list<const Link *>::const_iterator end() const;
};

#endif
